# Author
Vadim V. Balashoff (v.v.balashoff AT yandex.ru)

# Overview
«Winter Anathema» - attempt to create «my own» Fallout, based on these unused
resources and game concept of PARPG project. The date of the beginning of it
can be 08.08.2020. At that day I made a decision to start project based on
Love2D engine.

# Installation and Usage
'Dependencies' is currently shipped as libraries. So, you have to get project archive,
install love2d (11.0 or higher version).
To run project:
cd into winter_anathema
bin/.r.sh
or simply:
love .

# Dependencies
## used libraries:
  * colorlibrary (https://love2d.org/forums/viewtopic.php?t=84777) -- for colors, modified
  * i18n (https://github.com/kikito/i18n.lua) -- for i18n
  * outline (http://blogs.love2d.org/comment/173) -- for drawing outline
  * profile (https://bitbucket.org/itraykov/profile.lua/src/master/) -- for profiling
  * tiledloader (https://github.com/cxong/LoveTiledMap) -- for Tiled map support, modified
  * tween (https://github.com/kikito/tween.lua) -- for tween transitions

## unused for now:
  * love-zip (https://github.com/RamiLego4Game/LoveZip) -- for compress
  * menusystem (https://github.com/Astorek86/love2d-menuengine) -- heavily modified menuengine
  * zzlib (https://github.com/zerkman/zzlib.git) -- for decompress

## custom lbiraries:
  * cyrillic

# Documentation
ldoc [optional] is needed for doc automatic creation. It can be installed with:
luarocks install ldoc
To create current documentation you have to run:
/bin/ldoc.sh
